/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Mozilla browser.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2006-2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   David Hyatt <hyatt@mozilla.org> (Original Author)
 *   Nick Kreeger <nick.kreeger@park.edu>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#import <AppKit/AppKit.h>
#import <AddressBook/AddressBook.h>

@class ContactAutoCompleteTextField;
class nsIAbAutoCompleteSession;
class nsIAutoCompleteResults;
class nsIAutoCompleteListener;

/** 
 * This interface provides a auto-complete lookup service 
 * for both the Mozilla AdressBook and OS X Address Book
 * data sources.
 */
@interface ContactsAutoCompleteDataSource : NSObject
{
@private
  NSString* mSearchString;  // owned
  NSString* mErrorMessage;  // owned
  NSImage*  mIconImage;     // owned, use?
  
  NSMutableSet* mComboResults;  // owned, holds a sorted list of Gecko and OS X AB results.
  NSArray*      mABResults;     // owned, holds OS X AB results -> remove...

  nsIAbAutoCompleteSession* mSession;       // owned
  nsIAutoCompleteResults*   mGeckoResults;  // owned, holds Gecko AB results
  nsIAutoCompleteListener*  mListener;      // owned
  
  ContactAutoCompleteTextField* mOwnerTextField;
}

-(id)initWithContactAutoCompleteTextField:(ContactAutoCompleteTextField*)aContactTextField;

-(void)clearResults;
-(void)startSearch;

-(void)setSearchString:(NSString*)aSearchStr;
-(NSString*)searchString;

-(int)rowCount;
-(id)resultForRow:(int)aRow columnIdentifier:(NSString *)aColumnIdentifier;

//XXX remove setter...
-(void)setErrorMessage:(NSString*)error;
-(NSString*)errorMessage;

-(void)setResults:(nsIAutoCompleteResults*)results;
-(nsIAutoCompleteResults*) results;

@end
